com.doclinx.ftxml
Class CatalogMgrException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.doclinx.ftxml.CatalogMgrException
All Implemented Interfaces:
java.io.Serializable

public final class CatalogMgrException
extends java.lang.Exception

This class comprises the exception thrown by the CatalogManager class. All CatalogManager methods either return a value or void if OK. All errors are returned thrown with a message and the error code available to the catching code.

See Also:
CatalogManager, Serialized Form

Constructor Summary
CatalogMgrException()
          Default constructor -- should never see this exception.
CatalogMgrException(int iErrorCode)
          CatalogManager exception constructor with indicated error code.
CatalogMgrException(int iErrorCode, java.lang.Throwable rootCause)
          CatalogManager exception constructor with indicated error code and a root cause
CatalogMgrException(java.lang.String sErrorMessage)
          Deprecated. Never Used.
CatalogMgrException(java.lang.String sErrorMessage, int iErrorCode)
          CatalogManager exception constructor with indicated error code + message.
CatalogMgrException(java.lang.String sErrorMessage, int iErrorCode, java.lang.Throwable rootCause)
          CatalogManager exception constructor with indicated error code + message + root cause
 
Method Summary
 int getErrorCode()
          Returns the code number of the error for catching code.
 java.lang.String getErrorMessage(int iErrorCode)
          Returns an error message corresponding to the error number of the error.
 java.lang.String getErrorMessage(java.lang.String sErrorMessage, int iErrorCode)
          Returns an error message corresponding to the error number of the error.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CatalogMgrException

public CatalogMgrException()
Default constructor -- should never see this exception.

Throws:
**none**

CatalogMgrException

public CatalogMgrException(java.lang.String sErrorMessage)
Deprecated. Never Used.

CatalogManager exception with only a message.

Throws:
**none**

CatalogMgrException

public CatalogMgrException(int iErrorCode)
CatalogManager exception constructor with indicated error code.

Parameters:
iErrorCode - Code number of error, always < 0.
Throws:
**none**
See Also:
error codes for explanations.

CatalogMgrException

public CatalogMgrException(int iErrorCode,
                           java.lang.Throwable rootCause)
CatalogManager exception constructor with indicated error code and a root cause

Parameters:
iErrorCode - Code number of error, always < 0.
rootCause - Throwable that caused this exception to be thrown
Throws:
**none**
See Also:
error codes for explanations.

CatalogMgrException

public CatalogMgrException(java.lang.String sErrorMessage,
                           int iErrorCode)
CatalogManager exception constructor with indicated error code + message.

Parameters:
iErrorCode - Code number of error, always < 0.
sErrorMessage - Additional message to include with code message.
Throws:
**none**
See Also:
error codes values.

CatalogMgrException

public CatalogMgrException(java.lang.String sErrorMessage,
                           int iErrorCode,
                           java.lang.Throwable rootCause)
CatalogManager exception constructor with indicated error code + message + root cause

Parameters:
iErrorCode - Code number of error, always < 0.
sErrorMessage - Additional message to include with code message.
rootCause - Throwable that caused this exception to be thrown
Throws:
**none**
See Also:
error codes values.
Method Detail

getErrorCode

public int getErrorCode()
Returns the code number of the error for catching code.

Returns:
Error code of causing exception.
Throws:
**none**
See Also:
error codes values.

getErrorMessage

public java.lang.String getErrorMessage(int iErrorCode)
Returns an error message corresponding to the error number of the error.

Parameters:
iErrorCode - Numeric error code for this exception
Returns:
Message explaining error condition.
Throws:
**none**
See Also:
error codes values.

getErrorMessage

public java.lang.String getErrorMessage(java.lang.String sErrorMessage,
                                        int iErrorCode)
Returns an error message corresponding to the error number of the error.

Parameters:
iErrorCode - Numeric error code for this exception
sErrorMessage - Additional message to include with code message.
Returns:
Message explaining error condition.
Throws:
**none**
See Also:
error codes values.